UI for API Key Pair Management#13225
Open
bernardodemarco wants to merge 1 commit into
Open
Conversation
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #13225 +/- ##
============================================
+ Coverage 18.08% 18.09% +0.01%
- Complexity 16718 16749 +31
============================================
Files 6037 6041 +4
Lines 542609 543106 +497
Branches 66432 66509 +77
============================================
+ Hits 98136 98293 +157
- Misses 433446 433764 +318
- Partials 11027 11049 +22
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Member
|
@winterhazel a Jenkins job has been kicked to build UI QA env. I'll keep you posted as I make progress. |
|
UI build: ✔️ |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a CloudStack UI surface for the “multiple API key pairs per user” backend introduced in PR #9504, including listing key pairs, viewing key pair details/rules, and registering new key pairs with optional validity windows and rule-based permissions. It also includes a few backend/schema adjustments (description length increase, role permissions update, and parameter validation).
Changes:
- Added a new User tab and Keypair (API key pair) resource view to list and navigate API key pairs, including rule display.
- Added UI components to register API key pairs and to view/edit a key pair’s permission rules.
- Updated schema/entity/API command metadata related to API key pair descriptions and rule-description validation.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 13 comments.
Show a summary per file
| File | Description |
|---|---|
| ui/src/views/iam/GenerateApiKeyPair.vue | Modal/form to register an API key pair (name/description/dates/rules). |
| ui/src/views/iam/ApiKeyPairPermissionTable.vue | UI for building/viewing rule-permissions; supports drag ordering and read-only table view. |
| ui/src/views/AutogenView.vue | Adjusts param mapping for listUserKeys and resource selection behavior. |
| ui/src/config/section/user.js | Adds apikeypairs tab to the User view. |
| ui/src/config/section/keypair.js | Introduces a hidden “keypair” section for viewing API key pair details and rules. |
| ui/src/config/router.js | Registers the new keypair section routes. |
| ui/src/components/view/ListView.vue | Treats startdate/enddate as date fields for rendering. |
| ui/src/components/view/InfoCard.vue | Displays API/secret key fields for keypair resources; adjusts status/apikeyaccess display logic. |
| ui/src/components/view/DetailsTab.vue | Adds startdate/enddate date rendering and guards for empty values. |
| ui/src/components/view/ApiKeyPairsTab.vue | New User tab listing key pairs with bulk delete and link to keypair detail view. |
| ui/public/locales/pt_BR.json | Adds new UI strings (includes a typo). |
| ui/public/locales/en.json | Adds new UI strings for API key pair management. |
| engine/schema/src/main/resources/META-INF/db/schema-42210to42300.sql | Expands api_keypair.description size and grants role permissions for key APIs. |
| engine/schema/src/main/java/org/apache/cloudstack/acl/ApiKeyPairVO.java | Aligns entity field length with DB schema change. |
| api/src/main/java/org/apache/cloudstack/api/command/admin/user/RegisterUserKeysCmd.java | Adds parameter length metadata and introduces rule-description length validation (currently buggy). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| id: this.resource.id, | ||
| description: values.description ? values.description : null, | ||
| startdate: values.startDate ? parseDayJsObject({ value: values.startDate }) : null, | ||
| endDate: values.endDate ? parseDayJsObject({ value: values.endDate }) : null |
| return params | ||
| }, | ||
| handleSubmit (e) { | ||
| e.preventDefault() |
| </div> | ||
| <div class="rules-table__col rules-table__col--permission"> | ||
| <permission-editable | ||
| :defaultValue="newRulePermission" |
| } | ||
| this.deleteKeypairs(this.selectedItems) | ||
| }, | ||
| deleteKeypairs (keypairs) { |
| "label.secondarystoragelimit": "Limites do armazenamento secund\u00e1rio (GiB)", | ||
| "label.secretkey": "Chave secreta", | ||
| "label.secret.key": "Chave secreta", | ||
| "label.apikeyaccess": "Accesso a pares de chaves de API", |
Comment on lines
+157
to
+158
| GenerateApiKeyPair, | ||
| store |
| :columns="columns" | ||
| :dataSource="keypairs" | ||
| :rowKey="item => item.id" | ||
| :key="item => item.id" |
Comment on lines
+289
to
+313
| deleteKeypairs (keypairs) { | ||
| this.fetchLoading = true | ||
| keypairs.forEach(async keypair => { | ||
| try { | ||
| const jobId = await this.deleteKeyPair({ | ||
| keypairid: keypair.id | ||
| }) | ||
| await this.$pollJob({ | ||
| jobId, | ||
| action: { | ||
| isFetchData: false | ||
| }, | ||
| successMethod: () => { | ||
| eventBus.emit('update-resource-state', { selectedItems: this.selectedItems, resource: keypair.id, state: 'success' }) | ||
| }, | ||
| catchMethod: () => { | ||
| eventBus.emit('update-resource-state', { selectedItems: this.selectedItems, resource: keypair.id, state: 'failed' }) | ||
| } | ||
| }) | ||
| } catch (e) { | ||
| eventBus.emit('update-resource-state', { selectedItems: this.selectedItems, resource: keypair.id, state: 'failed' }) | ||
| } finally { | ||
| this.fetchLoading = false | ||
| } | ||
| }) |
Comment on lines
+289
to
+313
| deleteKeypairs (keypairs) { | ||
| this.fetchLoading = true | ||
| keypairs.forEach(async keypair => { | ||
| try { | ||
| const jobId = await this.deleteKeyPair({ | ||
| keypairid: keypair.id | ||
| }) | ||
| await this.$pollJob({ | ||
| jobId, | ||
| action: { | ||
| isFetchData: false | ||
| }, | ||
| successMethod: () => { | ||
| eventBus.emit('update-resource-state', { selectedItems: this.selectedItems, resource: keypair.id, state: 'success' }) | ||
| }, | ||
| catchMethod: () => { | ||
| eventBus.emit('update-resource-state', { selectedItems: this.selectedItems, resource: keypair.id, state: 'failed' }) | ||
| } | ||
| }) | ||
| } catch (e) { | ||
| eventBus.emit('update-resource-state', { selectedItems: this.selectedItems, resource: keypair.id, state: 'failed' }) | ||
| } finally { | ||
| this.fetchLoading = false | ||
| } | ||
| }) |
|
|
||
| String description = detail.get(ApiConstants.DESCRIPTION); | ||
| if (StringUtils.isNotEmpty(description)) { | ||
| if (permission.length() > 255) { |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
PR #9504 restructured and extended the implementation of API key pairs to improve flexibility and security. It is now possible to create multiple key pairs per user, define a specific permission scope for each key pair and specify a validation period during which they remain active.
This PR exposes these new features in the ACS graphical interface. Among the new functionalities, users can now list all key pairs associated with a user, view their details and permissions, and register new key pairs with validity periods and permission sets.
Additionally, some minor fixes and enhancements were introduced to the API key pair backend workflows, including:
Domain Admin,Resource AdminandUserwere granted access to thelistUserKeyRulesAPI;descriptioncolumn of thecloud.api_keypairtable was changed fromVARCHAR(100)toVARCHAR(1024); and,descriptioncolumn of thecloud.api_keypair_permissionstable isVARCHAR(255). However, theregisterUserKeysAPI currently do not validate the size of the corresponding API parameter. This validation has been introduced.Types of changes
Feature/Enhancement Scale or Bug Severity
Feature/Enhancement Scale
Screenshots (if appropriate):
2026-05-22.16-06-12.mp4
How Has This Been Tested?
The new UI sections were manually tested and their behavior was verified accordingly.
To test this patch, the backend must include PR #9504.